Extended error handling when a node fails by jonatan-qm · Pull Request #64 · qua-platform/qualibrate-runner

jonatan-qm · 2025-11-26T13:29:30Z

Part of solving https://quantum-machines.atlassian.net/browse/QUAL-1645

Enhances error reporting by extending the RunError model with optional details_headline and details fields. When nodes raise errors, these fields propagate structured error information for better debugging and frontend display.

A major part of the work here is adding comprehensive testing, including node end-to-end tests. The tests depends on qualibrate-core, so this PR will have failing tests until the qua-platform/qualibrate-core#143 PR in qualibrate-core has been merged!

Key Changes

Extended RunError model: Added details_headline and details fields to capture structured error information from node exceptions
Error propagation: Modified run_node() in run_job.py to extract and propagate error details from node run_summary.error to RunError
Comprehensive testing: Added extensive unit tests (config state, models, run_job) and integration tests that execute real test nodes
Documentation: Added explanatory comments throughout core modules
Minor fixes: Replaced deprecated HTTP_422_UNPROCESSABLE_ENTITY with HTTP_422_UNPROCESSABLE_CONTENT

Test Coverage

Unit tests: config state, models (common, last_run), and run_job execution
Integration tests: end-to-end node execution with test fixtures
Test fixtures: reusable test nodes including error-raising scenarios

…dels last run

…models/common.py and core/models/last_run.py

… into feat/extended-error-handling

…CESSABLE_CONTENT

…) nodes.

… into feat/extended-error-handling

…lass + a few unit tests

…o the RunError generated in run_node in run_job.py

…re from githib instead of from pip

… into feat/extended-error-handling

Elad-Zaharan · 2025-12-08T16:15:52Z

+        description="Error message to use",
+    )
+    error_type: str = Field(
+        default="ValueError",


maybe we could use exception type instead of string here and then when we check we dont need to compare strings

I think it is useful to be able to insert a string here - in particular for the manual testing when running this node via the frontend.

Elad-Zaharan · 2025-12-15T07:01:26Z

+    Scope is explicitly set to "function" to ensure each test gets fresh
+    node instances, maintaining test independence.
+    """
+    from qualibrate import QualibrationLibrary


is there an advantage putting it locally in the fixture?
we might use it in the future in more fixtures so maybe we should change the locations of the local imports to the whole file

You're right - simplifying it now, putting imports at the top of the file.

Elad-Zaharan · 2025-12-15T07:03:58Z

+
+
+@pytest.fixture(scope="function")
+def test_library() -> Any:


Why is it Any? don't we return QualibrationLibrary?
in general typing needs to be added in code wherever we can avoid using Any.

You're right! Fixing it.

Elad-Zaharan · 2025-12-15T07:05:56Z

+    """Integration tests for simple nodes without action system."""
+
+    def test_simple_node_success(
+        self, test_library: Any, fresh_state: Any


type hinting

You're right! Fixing it.

Elad-Zaharan · 2025-12-15T07:07:02Z

+        self, test_library: Any, fresh_state: Any
+    ) -> None:
+        """Test successful execution of simple node."""
+        node = test_library.nodes["node_raises_in_body"]


maybe we should change the name of the node because from the name it sounds like this node should raise an exception from body, but we actually test the node runs successfully

I changed the name to node_can_raise_in_body

Elad-Zaharan · 2025-12-15T07:35:02Z

+from qualang_tools.results import progress_counter
+from qualang_tools.units import unit
+from qualibrate import NodeParameters, QualibrationNode
+from qualibration_libs.data import XarrayDataFetcher


if we remove dependency in qualibration_libs this should be taken in count aswell i assume

Elad-Zaharan · 2025-12-15T15:23:43Z

+        assert last_run.name == long_name
+        assert len(last_run.name) > 300
+
+    def test_many_state_updates(self, aware_datetime: Any) -> None:


is it unnecessary?

You're right! I deleted the test.

Elad-Zaharan · 2025-12-15T15:24:31Z

+
+        assert len(last_run.state_updates) == 50
+
+    def test_complex_passed_parameters(self, aware_datetime: Any) -> None:


is it unnecessary?

You're right! I deleted the test.

Elad-Zaharan · 2025-12-15T16:11:50Z

+        assert fresh_state.last_run.error is None
+
+    @patch("qualibrate_runner.core.run_job.get_active_library_or_error")
+    def test_captures_workflow_snapshot_idx(


Do we need this tests after all the previous ones? if i understood right we checked it in the previous tests

You're right - I deleted the test.

Elad-Zaharan · 2025-12-15T16:21:50Z

+freezegun = "^1.2.0"
+xarray = "^2024.1.0"
+quam-builder = {git = "https://github.com/qua-platform/quam-builder.git"}
+#qualibration-libs = {path = "../qualibration-libs", develop = true}


we should remove dependency of qualibration-libs

… into feat/extended-error-handling

…ied test helper.

… into feat/extended-error-handling

jonatan-qm added 10 commits November 5, 2025 14:16

First unit tests in repo: Tests of config state, models common and mo…

d597128

…dels last run

Unit tests for run_job.py + small fix for test_models_last_run.py

8e17bce

Added clarifying comments to config/models.py, core/run_job.py, core/…

f6f6a33

…models/common.py and core/models/last_run.py

Merge main branch (commit '557b2731cca3e501c7092aabf826790ffa65d76e')…

e690dc9

… into feat/extended-error-handling

Changed comments - better explanations

d3c1d20

Replaced deprecated HTTP_422_UNPROCESSABLE_ENTITY with HTTP_422_UNPRO…

e0d995b

…CESSABLE_CONTENT

Adding integration tests to qualibrate-runner, that runs actual (test…

dff36ce

…) nodes.

Merge main branch (commit '1433607098ed0b3176eb284d95faa680430cece8')…

a4b0dfe

… into feat/extended-error-handling

Adding optional fields 'details_headline' and 'details' to RunError c…

e5ec79b

…lass + a few unit tests

Copy details for a RunError from the error that occured in a Node int…

cb2aa53

…o the RunError generated in run_node in run_job.py

jonatan-qm self-assigned this Nov 26, 2025

jonatan-qm added 8 commits November 26, 2025 15:17

More integration tests of failing nodes

eb5db43

Formatting fixes

8de7736

Trying to fix github action

7e4ab20

Again, trying to fix github action

606c367

Fixing github action - probably caused by the poetry.lock file

7a046c2

Trying to fix github actions

baa9b96

Trying to fix github actions

4a3bfb0

Fixing github actions

e9ab381

jonatan-qm mentioned this pull request Nov 27, 2025

Extended error handling when a node fails qua-platform/qualibrate-core#143

Merged

jonatan-qm added 5 commits November 27, 2025 10:08

Fixing most lint/type errors

4d73dbe

Fixing remaining type problems

a41f633

Fixing lint

3ed653a

Ensuring that github actions work for linting, by using qualibrate-co…

a036f0c

…re from githib instead of from pip

Fixing final type errors

4f532a6

jonatan-qm marked this pull request as ready for review November 27, 2025 09:54

jonatan-qm requested review from Elad-Zaharan and nulinspiratie November 27, 2025 10:00

Merge main branch (commit '3da29bf1a3ec7b68d1496c574f43c29dd72abbf6')…

0efdafb

… into feat/extended-error-handling

Elad-Zaharan reviewed Dec 9, 2025

View reviewed changes

Elad-Zaharan reviewed Dec 15, 2025

View reviewed changes

jonatan-qm added 5 commits December 23, 2025 13:09

Merge main branch (commit '37022f2fdb8e379ba98f7fbd2db5412e185a26a0')…

bdcd895

… into feat/extended-error-handling

Fixing test that broke with latest version of qualibration-libs

7834eb4

Some fixes based on PR feedback.

e653b4f

More fixes based on PR feedback.

c3ac090

Removing dependency on qualibration-libs, replacing it with a simplif…

4bbbb4f

…ied test helper.

jonatan-qm requested a review from Elad-Zaharan December 23, 2025 21:27

jonatan-qm added 2 commits January 6, 2026 10:13

Merge main branch (commit 'c036a08a144cd50a4c16ae731ca0a8efa1037204')…

1931793

… into feat/extended-error-handling

Did poetry lock (should fix lint errors)

e406daa

Elad-Zaharan approved these changes Jan 6, 2026

View reviewed changes

jonatan-qm merged commit f36dc06 into main Jan 6, 2026
2 of 3 checks passed

jonatan-qm deleted the feat/extended-error-handling branch January 6, 2026 10:20


		assert len(last_run.state_updates) == 50

		def test_complex_passed_parameters(self, aware_datetime: Any) -> None:

Uh oh!

Conversation

jonatan-qm commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jonatan-qm commented Nov 26, 2025 •

edited

Loading